docs/development/Building Manual.md

   1 #Building Manual.
   2
   3 The manual PDF file is generated by concatenating relevant markdown files and by transforming the result using Gimli to obtain the final PDF file. This steps are handled automatically by the ```build_manual.sh``` script located in the root of the repository next to the Makefile.
   4
   5 ##Requrements & Installation
   6 The PDF manual generation uses the Gimli for the conversion. It can be installed via ruby gems. On Debian based systems the installation steps are:
   7 ```bash
   8     sudo aptitude install rubygems wkhtmltopdf libxml2-dev libxslt-dev
   9     sudo gem1.8 install gimli
  10 ```
  11
  12 ##Configuration
  13 All markdown files need to be registered in the ```build_manual.sh``` file individually by modifying the ```doc_files``` variable / array:
  14 ```bash
  15 doc_files=( 'Configuration.md'
  16         'Board - CC3D.md'
  17         '...'
  18         '...'
  19 )
  20 ```
  21
  22 ##Restritions
  23 As the conversion via Gimli will not respect embedded image's DPI settings, the diemnsions of the image will be defined by the physical resolution in pixels. As a rule of thumb one should not embedd images wider than 600px in the markdown files.